OfflineRegion

class OfflineRegion : OfflineRegionInterface

An offline region represents an identifiable geographic region with optional metadata.

Functions

getGeometryDefinition
Link copied to clipboard
open fun getGeometryDefinition(): OfflineRegionGeometryDefinition
The geometry defining the region.
getIdentifier
Link copied to clipboard
open fun getIdentifier(): Long
The regions identifier
getMetadata
Link copied to clipboard
open fun getMetadata(): Array<Byte>
Arbitrary binary region metadata.
getTilePyramidDefinition
Link copied to clipboard
The tile pyramid defining the region.
invalidate
Link copied to clipboard
open fun invalidate(@NonNull() callback: AsyncOperationResultCallback)
Invalidate all the tiles for the region forcing to revalidatethe tiles with the server before using.
purge
Link copied to clipboard
open fun purge(@NonNull() callback: AsyncOperationResultCallback)
Remove an offline region from the database and perform any resourcesevictions necessary as a result.
setOfflineRegionDownloadState
Link copied to clipboard
open fun setOfflineRegionDownloadState(@NonNull() state: OfflineRegionDownloadState)
Sets the download state of an offline regionA region is either inactive (not downloading, but previously-downloadedresources are available for use), or active (resources are being downloadedor will be downloaded, if necessary, when network access is available).If the region is already in the given state, this call is ignored.
setOfflineRegionObserver
Link copied to clipboard
open fun setOfflineRegionObserver(@NonNull() observer: OfflineRegionObserver)
Register an observer to be notified when the state of the region changes.